//  Copyright 2021 Herald Project Contributors

//  SPDX-License-Identifier: Apache-2.0

//

#ifndef HERALD_BLE_PROTOCOLS_H

#define HERALD_BLE_PROTOCOLS_H

#include "../datatype/target_identifier.h"

#include "../engine/activities.h"

namespace herald {

namespace ble {

using namespace herald::datatype;

using namespace herald::engine;

// using HeraldConnectionCallback = std::function<void(const TargetIdentifier& toTarget, bool connNowOpen)>;

/**

 * The Herald protocols' low level activities. Implemented by each OS' provider

 */

class HeraldProtocolV1Provider {

public:

  HeraldProtocolV1Provider() = default;

  virtual ~HeraldProtocolV1Provider() = default;

  // FOR STD::ASYNC platforms:-

  // /** Opens a new connection. Returns true if successful or already connected */

  // virtual void openConnection(const TargetIdentifier& toTarget, const HeraldConnectionCallback& connCallback) = 0;

  // /** Closes a connection. Returns true if successful or already disconnected */

  // virtual void closeConnection(const TargetIdentifier& toTarget, const HeraldConnectionCallback& connCallback) = 0;

  // virtual void serviceDiscovery(Activity, CompletionCallback) = 0;

  // virtual void readPayload(Activity, CompletionCallback) = 0;

  // virtual void immediateSend(Activity, CompletionCallback) = 0;

  // virtual void immediateSendAll(Activity, CompletionCallback) = 0;

  // FOR OTHER PLATFORMS:-

  /** Opens a new connection. Returns true if successful or already connected. Will cause scanning and advertising to stop. */

  virtual bool openConnection(const TargetIdentifier& toTarget) = 0;

  /** Closes a connection. Returns true if successful or already disconnected */

  virtual bool closeConnection(const TargetIdentifier& toTarget) = 0;

  /** Restart scanning and advertising (if they were previously doing so) **/

  virtual void restartScanningAndAdvertising() = 0;

  virtual std::optional<Activity> serviceDiscovery(Activity) = 0;

  virtual std::optional<Activity> readPayload(Activity) = 0;

  // virtual std::optional<Activity> immediateSend(Activity) = 0;

  // virtual std::optional<Activity> immediateSendAll(Activity) = 0;

};

}

}

#endif